Add remote fuzzing documentation and AI agent skill by F-WRunTime · Pull Request #12 · runtimeverification/gitbook-kaas

F-WRunTime · 2026-03-25T02:30:33Z

Summary

New page: Remote Fuzzing (guides/kaas-cli_remote_fuzzing.md) — documents the kaas go test shorthand, .kaas-cli.toml configuration, Rust fuzzing via kaas-cli run, and how to view job results
Updated: run Command Documentation — adds Go/Rust test modes, --test-mode flag, --fuzz-targets, --execution-timeout, fuzzing capacity checks, and Go/Rust examples
New: AI Agent Skill (.cursor/skills/kaas-fuzzing/SKILL.md) — teaches AI agents when and why to write fuzz tests, how to use the CLI and API to submit fuzz jobs on KAAS, with Go and Rust fuzz test writing patterns
New: API Reference (.cursor/skills/kaas-fuzzing/api-reference.md) — documents fuzzing job endpoints, payloads, and response schemas for programmatic access

Context

These changes align the gitbook documentation with the feature/concurrent-fuzz-quota branch on the main kaas repo, which adds:

Fuzzing capacity/quota system (server + CLI + admin UI)
kaas go test CLI shorthand
.kaas-cli.toml persistent config
--fuzztime, --commit flags
goModuleRoot server-side field

Test plan

Verify new Remote Fuzzing page renders correctly in GitBook
Verify updated run command page renders correctly with tables
Verify SUMMARY.md links resolve correctly
Cross-reference CLI flag names against kaas repo feature/concurrent-fuzz-quota branch

- Add new Remote Fuzzing guide covering `kaas go test` shorthand, `.kaas-cli.toml` configuration, Rust fuzzing, and job results - Update `run` command docs with Go/Rust test modes, `--test-mode`, `--fuzz-targets`, `--execution-timeout`, and fuzzing examples - Add SKILL.md for AI agents: teaches when/why/how to write fuzz tests and submit them to KAAS via CLI and API - Add API reference for programmatic fuzzing job management Made-with: Cursor

F-WRunTime · 2026-03-25T02:31:43Z

Related PRs

These PRs contain the code changes that drove these documentation updates:

kaas: https://github.com/runtimeverification/kaas/pull/1466 — Go fuzzing: concurrent quota, enriched report, goModuleRoot & workflow improvements
kaas-compute-template: https://github.com/runtimeverification/kaas-compute-template/pull/82 — Go fuzzing: multi-target execution, goModuleRoot, workflow & script improvements

- Add AGENTS.md (universal standard, works with Cursor, Claude Code, Copilot, Codex) with KAAS fuzzing knowledge - Add CLAUDE.md for Claude Code users (compact format, <150 lines) - Add AI Agent Setup guide with install instructions for Cursor, Claude Code, ChatGPT, and the AGENTS.md universal standard - Update SUMMARY.md with new guide page Made-with: Cursor

Copilot

Pull request overview

This PR updates the GitBook documentation to cover remote fuzzing workflows on KaaS/KAAS (Go + Rust), expands the kaas-cli run docs to include fuzzing-related modes/flags, and adds “AI agent knowledge” artifacts (AGENTS/CLAUDE/Cursor skill + API reference) to help assistants generate fuzz tests and submit jobs.

Changes:

Add a new “Remote Fuzzing” guide documenting kaas go test, .kaas-cli.toml, and Go/Rust remote fuzz job workflows.
Extend kaas-cli run documentation with --test-mode (kontrol/forge/go/rust) and fuzzing-related flags/examples.
Add AI-agent consumable knowledge files and a fuzzing API reference.

Reviewed changes

Copilot reviewed 8 out of 8 changed files in this pull request and generated 5 comments.

Show a summary per file

File	Description
SUMMARY.md	Adds GitBook navigation links for Remote Fuzzing and AI Agent Setup
guides/kaas-cli_run_command.md	Documents new test modes and fuzzing flags/examples for `kaas-cli run`
guides/kaas-cli_remote_fuzzing.md	New guide for remote fuzzing, including `kaas go test` and `.kaas-cli.toml`
guides/kaas-ai-agent-setup.md	New guide describing how to install the agent knowledge files in various tools
AGENTS.md	New agent knowledge file (universal) with fuzzing + CLI/API usage patterns
CLAUDE.md	New Claude-specific knowledge file for fuzzing + CLI/API usage
.cursor/skills/kaas-fuzzing/SKILL.md	New Cursor skill describing fuzzing guidance and CLI usage
.cursor/skills/kaas-fuzzing/api-reference.md	New API reference for programmatic fuzz job submission/management

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot

Pull request overview

Copilot reviewed 8 out of 8 changed files in this pull request and generated 8 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

- Jekyll site at repo root with nav from _data/nav.yml - GitHub Actions deploy on push to main - Convert GitBook hints/embeds; fix internal links and image paths - Expand web setup (orgs, vaults, GitHub App); remove skill assets Made-with: Cursor

- Fix 'your test directory'; clarify remote fuzz needs vault+token, optional branch - Make --mode bullets and execution flow aware of --test-mode (kontrol/forge/go/rust) - Document kaas vs kaas-cli from same pip package; note -fuzz/--fuzz equivalence - AGENTS: check ParseMessage error on roundtrip; note API foundry vs CLI forge - CLAUDE: mention -fuzz/--fuzz in flag list Made-with: Cursor

Copilot

Pull request overview

Copilot reviewed 23 out of 26 changed files in this pull request and generated 6 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

- Put # KaaS before ## Get started on the home page for correct outline order - Replace missing assets/images screenshots with prose descriptions in web setup, device flow, and tagging guides so published pages do not 404 images - Reframe AI agent setup around cross-tool AGENTS.md/CLAUDE.md baseline and optional IDE-specific folders Made-with: Cursor

Copilot

Pull request overview

Copilot reviewed 24 out of 27 changed files in this pull request and generated 3 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-04-24T03:24:16Z

+## Step 7: Access tokens (CLI and API)
+
+1. Open your **Profile** (avatar menu).
+2. Go to **Access Tokens** (or [Profile → keys](https://kaas.runtimeverification.com/app/profile#tokens)).


This page links to access tokens at /app/profile#tokens, but other new docs point to /app/profile/keys. Please standardize on the correct token URL across the docs to avoid sending users to a stale/incorrect location.

Suggested change

2. Go to **Access Tokens** (or [Profile → keys](https://kaas.runtimeverification.com/app/profile#tokens)).

2. Go to **Access Tokens** (or [Profile → keys](https://kaas.runtimeverification.com/app/profile/keys)).

Copilot · 2026-04-24T03:24:17Z

 ## Guides

 * [Using KaaS CLI](/guides/kaas-cli_connecting-using-tokens.md)
 * [Authentification Using Device Flow](/guides/kaas-cli_connecting-using-device-flow.md)


The link text has a spelling error: “Authentification” → “Authentication”. Even though this is marked legacy, it’s still part of the repo-facing documentation and shows up in diffs/search results.

Suggested change

* [Authentification Using Device Flow](/guides/kaas-cli_connecting-using-device-flow.md)

* [Authentication Using Device Flow](/guides/kaas-cli_connecting-using-device-flow.md)

Copilot · 2026-04-24T03:24:17Z

+KAAS publishes **tool-agnostic** knowledge at the root of the [gitbook-kaas](https://github.com/runtimeverification/gitbook-kaas) repository so you can use the same material with **Cursor**, **Claude Code**, **GitHub Copilot**, **Codex**, **ChatGPT** (Projects / Custom GPTs), and other assistants that load project instructions or uploaded files.
+
+This guide explains how to wire that content into your workflow. The canonical copies live as **`AGENTS.md`** (widely supported) and **`CLAUDE.md`** (Claude-specific). Treat those files as the source of truth; any IDE-specific layout under `.cursor/` or similar in a fork is an **optional supplement**, not a different product contract.
+


The PR description mentions adding .cursor/skills/kaas-fuzzing/... (skill + API reference), but this repo change set instead ships the agent guidance via AGENTS.md / CLAUDE.md and this setup guide. Please align the PR description with what’s actually being added (or add the missing .cursor/skills/... files if they’re still intended).

F-WRunTime and others added 2 commits March 24, 2026 20:46

Merge branch 'main' into feature/fuzzing-docs-and-skill

d734051

F-WRunTime requested review from asavienko and yiyi-wang-rv April 1, 2026 05:11

yiyi-wang-rv requested a review from Copilot April 1, 2026 05:18

Copilot started reviewing on behalf of yiyi-wang-rv April 1, 2026 05:18 View session

Copilot AI reviewed Apr 1, 2026

View reviewed changes

yiyi-wang-rv requested a review from Copilot April 1, 2026 09:48

Copilot started reviewing on behalf of yiyi-wang-rv April 1, 2026 09:49 View session

Copilot AI reviewed Apr 1, 2026

View reviewed changes

F-WRunTime added 2 commits April 2, 2026 10:27

F-WRunTime enabled auto-merge April 2, 2026 19:35

F-WRunTime requested a review from Copilot April 14, 2026 20:18

Copilot started reviewing on behalf of F-WRunTime April 14, 2026 20:19 View session

Copilot AI reviewed Apr 14, 2026

View reviewed changes

F-WRunTime added 2 commits April 23, 2026 21:13

documenting how to use kaas-cli and foundry/forge to run tests

547d44d

F-WRunTime disabled auto-merge April 24, 2026 03:19

F-WRunTime requested a review from Copilot April 24, 2026 03:20

Copilot started reviewing on behalf of F-WRunTime April 24, 2026 03:20 View session

Copilot AI reviewed Apr 24, 2026

View reviewed changes

	2. Go to Access Tokens (or [Profile → keys](https://kaas.runtimeverification.com/app/profile#tokens)).
	2. Go to Access Tokens (or [Profile → keys](https://kaas.runtimeverification.com/app/profile/keys)).

	* [Authentification Using Device Flow](/guides/kaas-cli_connecting-using-device-flow.md)
	* [Authentication Using Device Flow](/guides/kaas-cli_connecting-using-device-flow.md)

		KAAS publishes tool-agnostic knowledge at the root of the [gitbook-kaas](https://github.com/runtimeverification/gitbook-kaas) repository so you can use the same material with Cursor, Claude Code, GitHub Copilot, Codex, ChatGPT (Projects / Custom GPTs), and other assistants that load project instructions or uploaded files.

		This guide explains how to wire that content into your workflow. The canonical copies live as `AGENTS.md` (widely supported) and `CLAUDE.md` (Claude-specific). Treat those files as the source of truth; any IDE-specific layout under `.cursor/` or similar in a fork is an optional supplement, not a different product contract.

Conversation

F-WRunTime commented Mar 25, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Context

Test plan

Uh oh!

F-WRunTime commented Mar 25, 2026

Related PRs

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI Apr 24, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 24, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 24, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

F-WRunTime commented Mar 25, 2026 •

edited

Loading